home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / fish / 726-750 / 746 / atbl / atblenglish.doc < prev    next >
Text File  |  1995-03-18  |  10KB  |  293 lines
  1.                 ATbl - User's manual
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8. 1. Foreword
  9.  
  10.     This manual describes release 2.20 of the utility ATbl. This program
  11. is (c)1991-1992 by Denis GOUNELLE, any commercial usage or  selling  without
  12. author's written authorization is  strictly  forbidden.  You  can  copy  and
  13. spread this program at the following conditions:
  14.  
  15.       - all the files must be provided
  16.       - none of the file must have been modified
  17.       - you don't charge more than $6 for copy fee
  18.  
  19.     In spite of several tests, no  warranty  is  made  that  there's  no
  20. errors in ATbl. YOU USE THIS PROGRAM AT YOUR OWN RISKS. In no event  will  I
  21. be liable for any damage, direct or indirect, resulting of the use of  ATbl.
  22.  
  23.  
  24. 2. Introduction
  25.  
  26.     ATbl is a complete and powerful program for table  formatting,    with
  27. three output modes :
  28.  
  29.     TXT  (text mode) very ugly, but may be useful for previewing
  30.          or testing.
  31.     PRT  (printer mode) much better  output  quality,  but  your
  32.          printer must be able to print IBM graphics  characters.
  33.     IFF  (IFF mode) the  best  result,  as  you  can  use  every
  34.          standard font, even proportional, and choose front  and
  35.          back  pen    colors.  Crossing   between   vertical     and
  36.          horizontal lines are optimised as much as possible. The
  37.          output is a regular IFF file that can be  load  by  any
  38.          decent word-processor or desktop-publishing program.
  39.  
  40.     ATbl is inspired by the "tbl" utility you find  usually  under  UNIX
  41. system, and by some others works Guillaume GIROD and I have done. My aim was
  42. to make table formatting as simple as just typing the data  to    put  is  the
  43. table. This works for TXT and IFF output mode, but for the PRT    mode  you'll
  44. have to specify at least two parameters.
  45.  
  46.     You can send me your suggestions and criticism writing to:
  47.  
  48.                  M. GOUNELLE Denis
  49.                   Boite 71
  50.                 6, rue des cailloux
  51.                92110 CLICHY - FRANCE
  52.  
  53.     The IFF file generation is based  upon    the  "ScreenSaver"  program,
  54. from "Amiga News Tech" issue number 24 (Jul/Aug 1991).
  55.  
  56.  
  57. 3. A quick demonstration
  58.  
  59.     Run your favorite text editor, and type in  a  few  lines  of  data,
  60. like:
  61.  
  62.         Slayer <tab> Seasons In The Abyss <tab> 1990
  63.         <tab> South of Heaven <tab> 1988
  64.         Sepultura <tab> Arise <tab> 1991
  65.         <tab> Beneath The Remains <tab> 1989
  66.         Anthrax <tab> Persistence Of Time <tab> 1990
  67.         Coroner <tab> Mental Vortex <tab> 1991
  68.  
  69. The <tab> notation stands for  one  tabulation    character.  If    your  editor
  70. replaces tabs by spaces, use "/" instead, and add the line ".tc  /"  at  the
  71. beginning of the file.
  72.     Now save this file. Run ATbl from the CLI, typing "ATbl <your file's
  73. name> TXT". You'll get something like this:
  74.  
  75.         +---------+--------------------+----+
  76.         |  Slayer |Seasons In The Abyss|1990|
  77.         |      |  South of Heaven   |1988|
  78.         |Sepultura|       Arise       |1991|
  79.         |      | Beneath The Remains|1989|
  80.         | Anthrax | Persistence Of Time|1990|
  81.         | Coroner |    Mental Vortex   |1991|
  82.         +---------+--------------------+----+
  83.  
  84. Now go back to your editor, and add the line ".ad llc" at the  beginning  of
  85. the file. Save it, and run ATbl again. The result is now:
  86.  
  87.         +---------+--------------------+----+
  88.         |Slayer   |Seasons In The Abyss|1990|
  89.         |      |South of Heaven     |1988|
  90.         |Sepultura|Arise           |1991|
  91.         |      |Beneath The Remains |1989|
  92.         |Anthrax  |Persistence Of Time |1990|
  93.         |Coroner  |Mental Vortex       |1991|
  94.         +---------+--------------------+----+
  95.  
  96. Last demonstration:  from  you    editor,  add  the  following  lines  at  the
  97. beginning of your file.
  98.  
  99.         .ad css
  100.         Some Great Albums
  101.         .nl
  102.  
  103. Save the file, and call ATbl once more. The result should be:
  104.  
  105.         +-----------------+--------------------+----+
  106.         |          Some Great Albums         |
  107.         +-----------------+--------------------+----+
  108.         |Slayer       |Seasons In The Abyss|1990|
  109.         |          |South of Heaven     |1988|
  110.         |Sepultura      |Arise           |1991|
  111.         |          |Beneath The Remains |1989|
  112.         |Anthrax      |Persistence Of Time |1990|
  113.         |Coroner      |Mental Vortex       |1991|
  114.         +-----------------+--------------------+----+
  115.  
  116.  
  117. 4. Reference Manual
  118.  
  119.     ATbl is invoked via the following CLI command:
  120.  
  121.          ATbl inputfile {TXT|PRT|IFF} [outputfile]
  122.  
  123. The input file is the file to be processed in order to    produce  the  table.
  124. The second argument specifies the output mode. The output file is  optional:
  125. if not specified, output will go to standard output in TXT mode, to  printer
  126. in PRT mode, but no IFF file will be produced in IFF mode.
  127.  
  128.     The input file contains  both  your  data  and    the  parameters  for
  129. formatting the table. Your data is a set of lines, with  the  text  of    each
  130. column separated by a tabulation character (this separation character can be
  131. changed). Vertical lines are automatically drawn between each  columns.  The
  132. parameters are specified by "requests": they must be  given  on  a  separate
  133. line, beginning with a period (.) character.
  134.     Here is the list of the requests. The string in brackets  after  the
  135. request names is made of :
  136.  
  137.     *    this request can only be used BEFORE any data line
  138.     T    used only in TXT output mode
  139.     P    used only in PRT output mode
  140.     I    used only in IFF output mode
  141.  
  142.  
  143. ad  ADjust
  144.     Syntax     : ad str
  145.     Description: specifies text adjusting  in  columns.  Each  character  in
  146.     "str" applies to the corresponding column, and may be one of :
  147.  
  148.         l        left aligned
  149.         r        right aligned
  150.         c        centered
  151.         s        this column is the continuation of the previous column
  152.  
  153. an  Auto-NewLine
  154.     Syntax     : an {0|1}
  155.     Description: enables (1) or disables (0) automatic generation of a  "nl"
  156.     request after each line of text
  157.  
  158. as  After String [*P]
  159.     Syntax     : as str
  160.     Description: specifies the printer sequence to go back in "normal" Amiga
  161.     mode. "str" is a list of decimal character codes, separated by spaces.
  162.  
  163. bp  Back Pen [*I]
  164.     Syntax     : bp n
  165.     Description: specifies back pen color ("n" is a color register  number).
  166.  
  167. bs  Before String [*P]
  168.     Syntax     : bs str
  169.     Description: specifies the printer sequence to go in "special" IBM mode.
  170.     "str" is a list of decimal character codes, separated by spaces.
  171.  
  172. cw  Column Width [*]
  173.     Syntax     : cw n m
  174.     Description: enforces width of column "n" to "m" characters  (or  pixels
  175.     in IFF mode).
  176.  
  177. fp  Front Pen [*I]
  178.     Syntax     : fp n
  179.     Description: specifies front pen color ("n" is a color register number).
  180.  
  181. ft  FonT [*I]
  182.     Syntax     : ft name size
  183.     Description: selects font for writing text.
  184.  
  185. hl  Horizontal Line
  186.     Syntax     : hl car [col]
  187.     Description: specifies horizontal lines aspect. The character "car"  may
  188.     be one of:
  189.  
  190.         b        no line
  191.         -        single line
  192.         =        double line
  193.  
  194.     The optional "col" argument is a list of  column  numbers  separated  by
  195.     comas. If missing, all columns are concerned.
  196.  
  197. lm  Left Margin [*]
  198.     Syntax     : lm n
  199.     Description: asks for a left margin of "n" characters (or pixels in  IFF
  200.     mode).
  201.  
  202. nl  New Line
  203.     Syntax     : nl
  204.     Description: draws an horizontal line.
  205.  
  206. np  Number of Planes [*I]
  207.     Syntax     : np n
  208.     Description: specifies number of planes to ask for ATbl's screen.
  209.  
  210. ph  Page Height [*I]
  211.     Syntax     : ph n
  212.     Description: specifies page height in pixels.
  213.  
  214. pw  Page Width [*I]
  215.     Syntax     : pw n
  216.     Description: specifies page width in pixels.
  217.  
  218. tc  Tab Character
  219.     Syntax     : tc [car]
  220.     Description: changes column separator character to    "car".  If  missing,
  221.     the default character is assumed (tab).
  222.  
  223. tp  Text Pen [I]
  224.     Syntax     : tp n [col]
  225.     Description: specifies text pen color ("n" is a color register  number).
  226.     The optional "col" argument is a list of  column  numbers  separated  by
  227.     comas. If missing, all columns are concerned. Please note that the    "fp"
  228.     request modifies color of all columns.
  229.  
  230. vl  Vertical Line
  231.     Syntax     : vl car [col]
  232.     Description: specifies vertical lines aspect. The character "car" may be
  233.     one of:
  234.  
  235.         b        no line
  236.         |        single line
  237.         #        double line
  238.  
  239.     The optional "col" argument is a list of  column  numbers  separated  by
  240.     comas. If missing, all columns are concerned. The column 0 is  the    left
  241.     margin.
  242.  
  243. xx  comment
  244.     Syntax     : xx str
  245.     Description: enters comment.
  246.  
  247.  
  248. 5. The IFF mode
  249.  
  250.     When you ask for IFF output mode, ATbl opens a special    screen.  The
  251. size of this screen is either the size given by the ".pw" and ".ph" requests
  252. or the size of Workbench screen. Default number of planes is one, and  table
  253. is drawn in color 0 on a color 1 background. Number of planes and colors  to
  254. use can be modified with the ".np", ".bp", ".tp", and ".fp" requests.
  255.     The mouse pointer is changed to a "Zz" bubble  while  the  table  is
  256. drawn, and the IFF file generated. Just click on left mouse  button  to  get
  257. the next page (if any), or on right mouse button to exit.
  258.  
  259.  
  260.  
  261.  
  262. 6. Workbench call
  263.  
  264.     ATbl can be runned from the Workbench. Output mode will  be  set  to
  265. "IFF mode", and no output file produced. Actually, Workbench call  has  been
  266. added only to allow table viewing directly from Worbench. All you have to do
  267. is to create a "Project" icon for your source file, and to put ATbl path  in
  268. the "Default Tool" field.
  269.  
  270.  
  271. 7. History
  272.  
  273. v1.00    16-Nov-91, 14864 bytes (Fish #583)
  274.     o First released version.
  275.  
  276. v2.00    24-Aug-92, 19324 bytes
  277.     o Recompiled with SAS/C 5.10b (with pragmas and optimization)
  278.     o Doesn't need "iff.library" anymore
  279.     o A lot of bugs fixed (no more Enforcer/Mungwall hits)
  280.  
  281. v2.10    07-Sep-92, 20760 bytes
  282.     o Can be called from Workbench
  283.     o Added "an" and "tp" requests
  284.  
  285. v2.20    16-Sep-92, 21460 bytes
  286.     o ".ph" and ".pw" request no longer required in IFF mode
  287.     o In PRT mode, output is send to printer if no output file is  given
  288.     o Display usage if bad arguments or no argument given.
  289.     o The  "atbl.font"  font  is  now  in  atbl  executable,  thanks  to
  290.     "FontConverter" (c)1992 by Andreas Baum.
  291.  
  292.  
  293.